[BETA] Get Campaigns Reporting.

Retrieve a list of campaigns and their reports.

GET /public/v1/toppie/reporting/campaigns

[BETA] Get Campaigns Reporting.

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/reporting/campaigns \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.topsort.com/public/v1/toppie/reporting/campaigns"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/toppie/reporting/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/toppie/reporting/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/toppie/reporting/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.topsort.com/public/v1/toppie/reporting/campaigns")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/toppie/reporting/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "hasMore": true,
  "campaigns": [
    {
      "adSpend": 1,
      "cpc": 123,
      "ctr": 123,
      "conversionRate": 123,
      "impressions": 1,
      "chargedImpressions": 1,
      "clicks": 1,
      "chargedClicks": 1,
      "purchaseCount": 1,
      "purchaseRevenue": 1,
      "roas": 123,
      "agencyCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignName": "<string>",
      "dailyBudget": 123,
      "isActive": true,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "targetRoas": 123,
      "cpm": 0,
      "acos": 0
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Query Parameters

next_page · string | null

Token for retrieving the next page.

limit · integer · default: 100

Maximum number of campaigns to retrieve.

Required range: 1 <= x <= 1000

order_by · enum<string> · default: name

The order dimension for the campaigns to be retrieved.

Available options: campaign_id, name, daily_budget, impressions, purchase_revenue, roas, cpc, cpm, ad_spend, is_active, ad_format, start_date, end_date, created_at, ctr, conversion_rate, purchase_count, charged_clicks, charged_impressions

direction · enum<string> · default: asc

The order direction for the campaigns to be retrieved.

Available options: asc, desc

start_date · string<date> | null

Start date for calculating metrics.

end_date · string<date> | null

End date for calculating metrics.

search · string · default: ""

A search string to filter the names of the campaigns by.

campaign_status · enum<string> · default: all

The campaign status to filter the campaigns by. Defaults to all statuses.

Available options: all, active, inactive

Response

200

application/json

Successful Response

hasMore · boolean · required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

campaigns · AgencyCampaignWithKPIS · object[] · required

Show child attributes

nextPage · string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="